<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: FoundationKVDatabase.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.fdb;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.foundationdb.Database;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.foundationdb.FDB;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import com.foundationdb.FDBException;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import com.foundationdb.NetworkOptions;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.concurrent.Executor;<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.annotation.PostConstruct;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import javax.annotation.PreDestroy;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.jsimpledb.kv.KVDatabase;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.jsimpledb.kv.KVDatabaseException;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * FoundationDB {@link KVDatabase} implementation.<a name="line.24"></a>
<span class="sourceLineNo">025</span> *<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> * Allows specifying a {@linkplain #setKeyPrefix key prefix} for all keys, allowing multiple independent databases.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;/p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>public class FoundationKVDatabase implements KVDatabase {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * The API version used by this class.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     */<a name="line.34"></a>
<span class="sourceLineNo">035</span>    public static final int API_VERSION = 300;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>    private final FDB fdb = FDB.selectAPIVersion(API_VERSION);<a name="line.37"></a>
<span class="sourceLineNo">038</span>    private final NetworkOptions options = this.fdb.options();<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>    private String clusterFilePath;<a name="line.40"></a>
<span class="sourceLineNo">041</span>    private byte[] databaseName = new byte[] { (byte)'D', (byte)'B' };<a name="line.41"></a>
<span class="sourceLineNo">042</span>    private byte[] keyPrefix;<a name="line.42"></a>
<span class="sourceLineNo">043</span>    private Executor executor;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span>    private Database database;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /**<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * Constructor.<a name="line.48"></a>
<span class="sourceLineNo">049</span>     *<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @throws FDBException if {@link #API_VERSION} is not supported<a name="line.50"></a>
<span class="sourceLineNo">051</span>     */<a name="line.51"></a>
<span class="sourceLineNo">052</span>    public FoundationKVDatabase() {<a name="line.52"></a>
<span class="sourceLineNo">053</span>    }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    /**<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * Get the {@link NetworkOptions} associated with this instance.<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * Options must be configured prior to {@link #start}.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @return network options<a name="line.59"></a>
<span class="sourceLineNo">060</span>     */<a name="line.60"></a>
<span class="sourceLineNo">061</span>    public NetworkOptions getNetworkOptions() {<a name="line.61"></a>
<span class="sourceLineNo">062</span>        return this.options;<a name="line.62"></a>
<span class="sourceLineNo">063</span>    }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    /**<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * Configure the {@link Executor} used for the FoundationDB networking event loop.<a name="line.66"></a>
<span class="sourceLineNo">067</span>     *<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * &lt;p&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * By default, the default thread pool is used to execute the FoundationDB network.<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * &lt;/p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @param executor executor for networking activity<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @see FDB#startNetwork(Executor) FDB.startNetwork()<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public void setExecutor(Executor executor) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        this.executor = executor;<a name="line.76"></a>
<span class="sourceLineNo">077</span>    }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * Configure the cluster file path. Default is null, which results in the default fdb.cluster file being used.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param clusterFilePath cluster file pathname<a name="line.82"></a>
<span class="sourceLineNo">083</span>     */<a name="line.83"></a>
<span class="sourceLineNo">084</span>    public void setClusterFilePath(String clusterFilePath) {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        this.clusterFilePath = clusterFilePath;<a name="line.85"></a>
<span class="sourceLineNo">086</span>    }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * Configure the database name. Currently the default value ({@code "DB".getBytes()}) is the only valid value.<a name="line.89"></a>
<span class="sourceLineNo">090</span>     *<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * @param databaseName database name<a name="line.91"></a>
<span class="sourceLineNo">092</span>     */<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public void setDatabaseName(byte[] databaseName) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        this.databaseName = databaseName;<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    /**<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * Get the key prefix for all keys.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     *<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * @return key prefix, or null if there is none configured<a name="line.100"></a>
<span class="sourceLineNo">101</span>     */<a name="line.101"></a>
<span class="sourceLineNo">102</span>    public byte[] getKeyPrefix() {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        return this.keyPrefix.clone();<a name="line.103"></a>
<span class="sourceLineNo">104</span>    }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /**<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * Configure a prefix for all keys. The prefix will be added/removed automatically with all access.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * The default prefix is null, which is equivalent to an empty prefix.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     *<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * &lt;p&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * The key prefix may not be changed after this instance has {@linkplain #start started}.<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * &lt;/p&gt;<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param keyPrefix new prefix, or null for none<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * @throws IllegalArgumentException if {@code keyPrefix} starts with {@code 0xff}<a name="line.115"></a>
<span class="sourceLineNo">116</span>     * @throws IllegalStateException if this instance has already been {@linkplain #start started}<a name="line.116"></a>
<span class="sourceLineNo">117</span>     */<a name="line.117"></a>
<span class="sourceLineNo">118</span>    public void setKeyPrefix(byte[] keyPrefix) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>        if (this.database != null)<a name="line.119"></a>
<span class="sourceLineNo">120</span>            throw new IllegalStateException("already started");<a name="line.120"></a>
<span class="sourceLineNo">121</span>        if (keyPrefix != null &amp;&amp; keyPrefix.length &gt; 0 &amp;&amp; keyPrefix[0] == (byte)0xff)<a name="line.121"></a>
<span class="sourceLineNo">122</span>            throw new IllegalArgumentException("prefix starts with 0xff");<a name="line.122"></a>
<span class="sourceLineNo">123</span>        this.keyPrefix = keyPrefix != null &amp;&amp; keyPrefix.length &gt; 0 ? keyPrefix.clone() : null;<a name="line.123"></a>
<span class="sourceLineNo">124</span>    }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span>    /**<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * Get the underlying {@link Database} associated with this instance.<a name="line.127"></a>
<span class="sourceLineNo">128</span>     *<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * @return the associated {@link Database}<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * @throws IllegalStateException if this instance has not yet been {@linkplain #start started}<a name="line.130"></a>
<span class="sourceLineNo">131</span>     */<a name="line.131"></a>
<span class="sourceLineNo">132</span>    public Database getDatabase() {<a name="line.132"></a>
<span class="sourceLineNo">133</span>        if (this.database == null)<a name="line.133"></a>
<span class="sourceLineNo">134</span>            throw new IllegalStateException("not started");<a name="line.134"></a>
<span class="sourceLineNo">135</span>        return this.database;<a name="line.135"></a>
<span class="sourceLineNo">136</span>    }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span>    /**<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * Start this instance. This method must be called prior to creating any transactions.<a name="line.139"></a>
<span class="sourceLineNo">140</span>     *<a name="line.140"></a>
<span class="sourceLineNo">141</span>     * @throws IllegalStateException if this instance has already been {@linkplain #start started}<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @throws IllegalStateException if this instance has already been {@linkplain #stop stopped}<a name="line.142"></a>
<span class="sourceLineNo">143</span>     */<a name="line.143"></a>
<span class="sourceLineNo">144</span>    @PostConstruct<a name="line.144"></a>
<span class="sourceLineNo">145</span>    public synchronized void start() {<a name="line.145"></a>
<span class="sourceLineNo">146</span>        if (this.database != null)<a name="line.146"></a>
<span class="sourceLineNo">147</span>            throw new IllegalStateException("already started");<a name="line.147"></a>
<span class="sourceLineNo">148</span>        this.database = this.fdb.open(this.clusterFilePath, this.databaseName);<a name="line.148"></a>
<span class="sourceLineNo">149</span>        if (this.executor != null)<a name="line.149"></a>
<span class="sourceLineNo">150</span>            this.fdb.startNetwork(this.executor);<a name="line.150"></a>
<span class="sourceLineNo">151</span>        else<a name="line.151"></a>
<span class="sourceLineNo">152</span>            this.fdb.startNetwork();<a name="line.152"></a>
<span class="sourceLineNo">153</span>    }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span>    /**<a name="line.155"></a>
<span class="sourceLineNo">156</span>     * Stop this instance. Invokes {@link FDB#stopNetwork}. Does nothing if not {@linkplain #start started}.<a name="line.156"></a>
<span class="sourceLineNo">157</span>     *<a name="line.157"></a>
<span class="sourceLineNo">158</span>     * @throws FDBException if an error occurs<a name="line.158"></a>
<span class="sourceLineNo">159</span>     */<a name="line.159"></a>
<span class="sourceLineNo">160</span>    @PreDestroy<a name="line.160"></a>
<span class="sourceLineNo">161</span>    public synchronized void stop() {<a name="line.161"></a>
<span class="sourceLineNo">162</span>        if (this.database == null)<a name="line.162"></a>
<span class="sourceLineNo">163</span>            return;<a name="line.163"></a>
<span class="sourceLineNo">164</span>        this.fdb.stopNetwork();<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * Create a new transaction.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @throws IllegalStateException if this instance has not yet been {@linkplain #start started}<a name="line.170"></a>
<span class="sourceLineNo">171</span>     * @throws IllegalStateException if this instance has already been {@linkplain #stop stopped}<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * @throws KVDatabaseException if an unexpected error occurs<a name="line.172"></a>
<span class="sourceLineNo">173</span>     */<a name="line.173"></a>
<span class="sourceLineNo">174</span>    @Override<a name="line.174"></a>
<span class="sourceLineNo">175</span>    public FoundationKVTransaction createTransaction() {<a name="line.175"></a>
<span class="sourceLineNo">176</span>        if (this.database == null)<a name="line.176"></a>
<span class="sourceLineNo">177</span>            throw new IllegalStateException("not started");<a name="line.177"></a>
<span class="sourceLineNo">178</span>        try {<a name="line.178"></a>
<span class="sourceLineNo">179</span>            return new FoundationKVTransaction(this, this.keyPrefix);<a name="line.179"></a>
<span class="sourceLineNo">180</span>        } catch (FDBException e) {<a name="line.180"></a>
<span class="sourceLineNo">181</span>            throw new KVDatabaseException(this, e);<a name="line.181"></a>
<span class="sourceLineNo">182</span>        }<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span>}<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>




























































</pre>
</div>
</body>
</html>
